home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / DJLSR106.ARJ / RANDOM.C < prev    next >
C/C++ Source or Header  |  1992-03-02  |  14KB  |  375 lines
  1. /* This is file RANDOM.C */
  2. /* This file may have been modified by DJ Delorie (Jan 1991).  If so,
  3. ** these modifications are Coyright (C) 1991 DJ Delorie, 24 Kirsten Ave,
  4. ** Rochester NH, 03867-2954, USA.
  5. */
  6.  
  7. /*
  8.  * Copyright (c) 1983 Regents of the University of California.
  9.  * All rights reserved.
  10.  *
  11.  * Redistribution and use in source and binary forms are permitted
  12.  * provided that: (1) source distributions retain this entire copyright
  13.  * notice and comment, and (2) distributions including binaries display
  14.  * the following acknowledgement:  ``This product includes software
  15.  * developed by the University of California, Berkeley and its contributors''
  16.  * in the documentation or other materials provided with the distribution
  17.  * and in all advertising materials mentioning features or use of this
  18.  * software. Neither the name of the University nor the names of its
  19.  * contributors may be used to endorse or promote products derived
  20.  * from this software without specific prior written permission.
  21.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  22.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  23.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  24.  */
  25.  
  26. #if defined(LIBC_SCCS) && !defined(lint)
  27. static char sccsid[] = "@(#)random.c    5.7 (Berkeley) 6/1/90";
  28. #endif /* LIBC_SCCS and not lint */
  29.  
  30. #include <stdio.h>
  31.  
  32. /*
  33.  * random.c:
  34.  * An improved random number generation package.  In addition to the standard
  35.  * rand()/srand() like interface, this package also has a special state info
  36.  * interface.  The initstate() routine is called with a seed, an array of
  37.  * bytes, and a count of how many bytes are being passed in; this array is then
  38.  * initialized to contain information for random number generation with that
  39.  * much state information.  Good sizes for the amount of state information are
  40.  * 32, 64, 128, and 256 bytes.  The state can be switched by calling the
  41.  * setstate() routine with the same array as was initiallized with initstate().
  42.  * By default, the package runs with 128 bytes of state information and
  43.  * generates far better random numbers than a linear congruential generator.
  44.  * If the amount of state information is less than 32 bytes, a simple linear
  45.  * congruential R.N.G. is used.
  46.  * Internally, the state information is treated as an array of longs; the
  47.  * zeroeth element of the array is the type of R.N.G. being used (small
  48.  * integer); the remainder of the array is the state information for the
  49.  * R.N.G.  Thus, 32 bytes of state information will give 7 longs worth of
  50.  * state information, which will allow a degree seven polynomial.  (Note: the 
  51.  * zeroeth word of state information also has some other information stored
  52.  * in it -- see setstate() for details).
  53.  * The random number generation technique is a linear feedback shift register
  54.  * approach, employing trinomials (since there are fewer terms to sum up that
  55.  * way).  In this approach, the least significant bit of all the numbers in
  56.  * the state table will act as a linear feedback shift register, and will have
  57.  * period 2^deg - 1 (where deg is the degree of the polynomial being used,
  58.  * assuming that the polynomial is irreducible and primitive).  The higher
  59.  * order bits will have longer periods, since their values are also influenced
  60.  * by pseudo-random carries out of the lower bits.  The total period of the
  61.  * generator is approximately deg*(2**deg - 1); thus doubling the amount of
  62.  * state information has a vast influence on the period of the generator.
  63.  * Note: the deg*(2**deg - 1) is an approximation only good for large deg,
  64.  * when the period of the shift register is the dominant factor.  With deg
  65.  * equal to seven, the period is actually much longer than the 7*(2**7 - 1)
  66.  * predicted by this formula.
  67.  */
  68.  
  69.  
  70.  
  71. /*
  72.  * For each of the currently supported random number generators, we have a
  73.  * break value on the amount of state information (you need at least this
  74.  * many bytes of state info to support this random number generator), a degree
  75.  * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
  76.  * the separation between the two lower order coefficients of the trinomial.
  77.  */
  78.  
  79. #define        TYPE_0        0        /* linear congruential */
  80. #define        BREAK_0        8
  81. #define        DEG_0        0
  82. #define        SEP_0        0
  83.  
  84. #define        TYPE_1        1        /* x**7 + x**3 + 1 */
  85. #define        BREAK_1        32
  86. #define        DEG_1        7
  87. #define        SEP_1        3
  88.  
  89. #define        TYPE_2        2        /* x**15 + x + 1 */
  90. #define        BREAK_2        64
  91. #define        DEG_2        15
  92. #define        SEP_2        1
  93.  
  94. #define        TYPE_3        3        /* x**31 + x**3 + 1 */
  95. #define        BREAK_3        128
  96. #define        DEG_3        31
  97. #define        SEP_3        3
  98.  
  99. #define        TYPE_4        4        /* x**63 + x + 1 */
  100. #define        BREAK_4        256
  101. #define        DEG_4        63
  102. #define        SEP_4        1
  103.  
  104.  
  105. /*
  106.  * Array versions of the above information to make code run faster -- relies
  107.  * on fact that TYPE_i == i.
  108.  */
  109.  
  110. #define        MAX_TYPES    5        /* max number of types above */
  111.  
  112. static  int        degrees[ MAX_TYPES ]    = { DEG_0, DEG_1, DEG_2,
  113.                                 DEG_3, DEG_4 };
  114.  
  115. static  int        seps[ MAX_TYPES ]    = { SEP_0, SEP_1, SEP_2,
  116.                                 SEP_3, SEP_4 };
  117.  
  118.  
  119.  
  120. /*
  121.  * Initially, everything is set up as if from :
  122.  *        initstate( 1, &randtbl, 128 );
  123.  * Note that this initialization takes advantage of the fact that srandom()
  124.  * advances the front and rear pointers 10*rand_deg times, and hence the
  125.  * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
  126.  * element of the state information, which contains info about the current
  127.  * position of the rear pointer is just
  128.  *    MAX_TYPES*(rptr - state) + TYPE_3 == TYPE_3.
  129.  */
  130.  
  131. static  long        randtbl[ DEG_3 + 1 ]    = { TYPE_3,
  132.                 0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342, 
  133.                 0xde3b81e0, 0xdf0a6fb5, 0xf103bc02, 0x48f340fb, 
  134.                 0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd, 
  135.                 0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86, 
  136.                 0xda672e2a, 0x1588ca88, 0xe369735d, 0x904f35f7, 
  137.                 0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc, 
  138.                 0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b, 
  139.                     0xf5ad9d0e, 0x8999220b, 0x27fb47b9 };
  140.  
  141. /*
  142.  * fptr and rptr are two pointers into the state info, a front and a rear
  143.  * pointer.  These two pointers are always rand_sep places aparts, as they cycle
  144.  * cyclically through the state information.  (Yes, this does mean we could get
  145.  * away with just one pointer, but the code for random() is more efficient this
  146.  * way).  The pointers are left positioned as they would be from the call
  147.  *            initstate( 1, randtbl, 128 )
  148.  * (The position of the rear pointer, rptr, is really 0 (as explained above
  149.  * in the initialization of randtbl) because the state table pointer is set
  150.  * to point to randtbl[1] (as explained below).
  151.  */
  152.  
  153. static  long        *fptr            = &randtbl[ SEP_3 + 1 ];
  154. static  long        *rptr            = &randtbl[ 1 ];
  155.  
  156.  
  157.  
  158. /*
  159.  * The following things are the pointer to the state information table,
  160.  * the type of the current generator, the degree of the current polynomial
  161.  * being used, and the separation between the two pointers.
  162.  * Note that for efficiency of random(), we remember the first location of
  163.  * the state information, not the zeroeth.  Hence it is valid to access
  164.  * state[-1], which is used to store the type of the R.N.G.
  165.  * Also, we remember the last location, since this is more efficient than
  166.  * indexing every time to find the address of the last element to see if
  167.  * the front and rear pointers have wrapped.
  168.  */
  169.  
  170. static  long        *state            = &randtbl[ 1 ];
  171.  
  172. static  int        rand_type        = TYPE_3;
  173. static  int        rand_deg        = DEG_3;
  174. static  int        rand_sep        = SEP_3;
  175.  
  176. static  long        *end_ptr        = &randtbl[ DEG_3 + 1 ];
  177.  
  178.  
  179.  
  180. /*
  181.  * srandom:
  182.  * Initialize the random number generator based on the given seed.  If the
  183.  * type is the trivial no-state-information type, just remember the seed.
  184.  * Otherwise, initializes state[] based on the given "seed" via a linear
  185.  * congruential generator.  Then, the pointers are set to known locations
  186.  * that are exactly rand_sep places apart.  Lastly, it cycles the state
  187.  * information a given number of times to get rid of any initial dependencies
  188.  * introduced by the L.C.R.N.G.
  189.  * Note that the initialization of randtbl[] for default usage relies on
  190.  * values produced by this routine.
  191.  */
  192.  
  193. srandom( x )
  194.  
  195.     unsigned        x;
  196. {
  197.         register  int        i, j;
  198.     long random();
  199.  
  200.     if(  rand_type  ==  TYPE_0  )  {
  201.         state[ 0 ] = x;
  202.     }
  203.     else  {
  204.         j = 1;
  205.         state[ 0 ] = x;
  206.         for( i = 1; i < rand_deg; i++ )  {
  207.         state[i] = 1103515245*state[i - 1] + 12345;
  208.         }
  209.         fptr = &state[ rand_sep ];
  210.         rptr = &state[ 0 ];
  211.         for( i = 0; i < 10*rand_deg; i++ )  random();
  212.     }
  213. }
  214.  
  215.  
  216.  
  217. /*
  218.  * initstate:
  219.  * Initialize the state information in the given array of n bytes for
  220.  * future random number generation.  Based on the number of bytes we
  221.  * are given, and the break values for the different R.N.G.'s, we choose
  222.  * the best (largest) one we can and set things up for it.  srandom() is
  223.  * then called to initialize the state information.
  224.  * Note that on return from srandom(), we set state[-1] to be the type
  225.  * multiplexed with the current value of the rear pointer; this is so
  226.  * successive calls to initstate() won't lose this information and will
  227.  * be able to restart with setstate().
  228.  * Note: the first thing we do is save the current state, if any, just like
  229.  * setstate() so that it doesn't matter when initstate is called.
  230.  * Returns a pointer to the old state.
  231.  */
  232.  
  233. char  *
  234. initstate( seed, arg_state, n )
  235.  
  236.     unsigned        seed;            /* seed for R. N. G. */
  237.     char        *arg_state;        /* pointer to state array */
  238.     int            n;            /* # bytes of state info */
  239. {
  240.     register  char        *ostate        = (char *)( &state[ -1 ] );
  241.  
  242.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  243.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  244.     if(  n  <  BREAK_1  )  {
  245.         if(  n  <  BREAK_0  )  {
  246.         fprintf( stderr, "initstate: not enough state (%d bytes); ignored.\n", n );
  247.         return 0;
  248.         }
  249.         rand_type = TYPE_0;
  250.         rand_deg = DEG_0;
  251.         rand_sep = SEP_0;
  252.     }
  253.     else  {
  254.         if(  n  <  BREAK_2  )  {
  255.         rand_type = TYPE_1;
  256.         rand_deg = DEG_1;
  257.         rand_sep = SEP_1;
  258.         }
  259.         else  {
  260.         if(  n  <  BREAK_3  )  {
  261.             rand_type = TYPE_2;
  262.             rand_deg = DEG_2;
  263.             rand_sep = SEP_2;
  264.         }
  265.         else  {
  266.             if(  n  <  BREAK_4  )  {
  267.             rand_type = TYPE_3;
  268.             rand_deg = DEG_3;
  269.             rand_sep = SEP_3;
  270.             }
  271.             else  {
  272.             rand_type = TYPE_4;
  273.             rand_deg = DEG_4;
  274.             rand_sep = SEP_4;
  275.             }
  276.         }
  277.         }
  278.     }
  279.     state = &(  ( (long *)arg_state )[1]  );    /* first location */
  280.     end_ptr = &state[ rand_deg ];    /* must set end_ptr before srandom */
  281.     srandom( seed );
  282.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  283.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  284.     return( ostate );
  285. }
  286.  
  287.  
  288.  
  289. /*
  290.  * setstate:
  291.  * Restore the state from the given state array.
  292.  * Note: it is important that we also remember the locations of the pointers
  293.  * in the current state information, and restore the locations of the pointers
  294.  * from the old state information.  This is done by multiplexing the pointer
  295.  * location into the zeroeth word of the state information.
  296.  * Note that due to the order in which things are done, it is OK to call
  297.  * setstate() with the same state as the current state.
  298.  * Returns a pointer to the old state information.
  299.  */
  300.  
  301. char  *
  302. setstate( arg_state )
  303.  
  304.     char        *arg_state;
  305. {
  306.     register  long        *new_state    = (long *)arg_state;
  307.     register  int        type        = new_state[0]%MAX_TYPES;
  308.     register  int        rear        = new_state[0]/MAX_TYPES;
  309.     char            *ostate        = (char *)( &state[ -1 ] );
  310.  
  311.     if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  312.     else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  313.     switch(  type  )  {
  314.         case  TYPE_0:
  315.         case  TYPE_1:
  316.         case  TYPE_2:
  317.         case  TYPE_3:
  318.         case  TYPE_4:
  319.         rand_type = type;
  320.         rand_deg = degrees[ type ];
  321.         rand_sep = seps[ type ];
  322.         break;
  323.  
  324.         default:
  325.         fprintf( stderr, "setstate: state info has been munged; not changed.\n" );
  326.     }
  327.     state = &new_state[ 1 ];
  328.     if(  rand_type  !=  TYPE_0  )  {
  329.         rptr = &state[ rear ];
  330.         fptr = &state[ (rear + rand_sep)%rand_deg ];
  331.     }
  332.     end_ptr = &state[ rand_deg ];        /* set end_ptr too */
  333.     return( ostate );
  334. }
  335.  
  336.  
  337.  
  338. /*
  339.  * random:
  340.  * If we are using the trivial TYPE_0 R.N.G., just do the old linear
  341.  * congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
  342.  * same in all ther other cases due to all the global variables that have been
  343.  * set up.  The basic operation is to add the number at the rear pointer into
  344.  * the one at the front pointer.  Then both pointers are advanced to the next
  345.  * location cyclically in the table.  The value returned is the sum generated,
  346.  * reduced to 31 bits by throwing away the "least random" low bit.
  347.  * Note: the code takes advantage of the fact that both the front and
  348.  * rear pointers can't wrap on the same call by not testing the rear
  349.  * pointer if the front one has wrapped.
  350.  * Returns a 31-bit random number.
  351.  */
  352.  
  353. long
  354. random()
  355. {
  356.     long        i;
  357.     
  358.     if(  rand_type  ==  TYPE_0  )  {
  359.         i = state[0] = ( state[0]*1103515245 + 12345 )&0x7fffffff;
  360.     }
  361.     else  {
  362.         *fptr += *rptr;
  363.         i = (*fptr >> 1)&0x7fffffff;    /* chucking least random bit */
  364.         if(  ++fptr  >=  end_ptr  )  {
  365.         fptr = state;
  366.         ++rptr;
  367.         }
  368.         else  {
  369.         if(  ++rptr  >=  end_ptr  )  rptr = state;
  370.         }
  371.     }
  372.     return( i );
  373. }
  374.  
  375.